docs: miscellaneous section by hejsztynx · Pull Request #723 · software-mansion/react-native-enriched-html

hejsztynx · 2026-07-23T10:56:11Z

Summary

Added the Misc section to the docs.

Copilot

Pull request overview

Adds initial content for the “Misc” documentation section of React Native Enriched HTML, replacing TODO placeholders with contributor guidance and platform/feature notes.

Changes:

Add initial “Roadmap” and “Known limitations” pages with cross-links.
Add a comprehensive “Contributing” page describing the dev workflow and test commands.
Replace compatibility.md with a new compatibility.mdx page outlining platform differences and compatibility notes.

Reviewed changes

Copilot reviewed 6 out of 6 changed files in this pull request and generated 3 comments.

Show a summary per file

File	Description
docs/docs/misc/roadmap.md	Adds a roadmap page describing planned feature areas.
docs/docs/misc/known-limitations.md	Documents current cross-platform limitations and links to related docs.
docs/docs/misc/contributing.md	Adds detailed contributor workflow, tooling, and testing guidance.
docs/docs/misc/compatibility.mdx	Introduces a compatibility/platform-differences page (MDX).
docs/docs/misc/compatibility.md	Removes the previous placeholder compatibility page.
docs/docs/misc/comparison-with-other-libraries.md	Leaves the comparison page as header-only (needs placeholder/content).

Comments suppressed due to low confidence (1)

docs/docs/misc/comparison-with-other-libraries.md:6

This page currently renders as an empty section (header only). Adding a short placeholder helps readers understand it’s intentionally unfinished until the comparison content is added.

# Comparison with other libraries

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Copilot

Pull request overview

Copilot reviewed 8 out of 8 changed files in this pull request and generated 2 comments.

Comments suppressed due to low confidence (3)

docs/src/components/Compatibility/EnrichedCompatibility.tsx:51

The first cell in each body row is effectively a row header (the library version). Using <th scope="row"> instead of <td> improves table semantics/accessibility.

              <td>
                <Version version={version} />
              </td>

docs/docs/misc/compatibility.mdx:75

## HTML is not sanitized (Mobile) is placed after ## Platform differences, but as a level-2 heading it breaks out of that section, and the following ### React Native layout ref methods becomes nested under it. Make this a level-3 heading so both items remain part of "Platform differences".

## HTML is not sanitized (Mobile)

On iOS and Android, the library does not sanitize HTML. It makes no guarantees that the markup it accepts or produces is safe. You are fully responsible for sanitizing any HTML you persist, render elsewhere, or accept from untrusted sources.

Sanitization _is_ enforced on the web, as injecting unsafe HTML directly into the DOM poses severe security risks (like XSS).

### React Native layout ref methods

docs/docs/misc/roadmap.md:23

"ACA" is typically the Affordable Care Act and isn't an accessibility standard; for accessibility compliance in the US it's usually "ADA" (or Section 508). Consider replacing this to avoid confusing readers.

Support for screen readers and accessibility APIs,
delivering a rich, inclusive text editing experience while aligning with WCAG
and ACA standards.

Co-authored-by: Kacper Żółkiewski <74975508+kacperzolkiewski@users.noreply.github.com>

Co-authored-by: Mikołaj Szydłowski <9szydlowski9@gmail.com>

exploIF · 2026-08-11T16:21:55Z

@@ -0,0 +1,74 @@
+import React from 'react';
+import { No, Version, Yes } from './index';
+


I would like to drop official react-native 0.81 support in 1.2.x. Can we add that to our table? Please mark version as 1.2.x (next)

exploIF · 2026-08-11T16:24:00Z

+`'auto'`. This applies both to `setTextAlignment('justify')` and to the `justify` value reported by
+`onChangeState`.
+
+### `ellipsizeMode` with multiple lines (Android)


This works the same in the RN TextInput, right? If so, can we add it here so users now it's consistent behavior?

exploIF · 2026-08-11T16:24:54Z

+native editing menu isn't available at all, so the prop is ignored - build your
+own UI instead.
+
+### Return key behaviour


Same here, I believe those limitations are in the RN as well. Would be good to mark it here as well

exploIF · 2026-08-11T16:25:57Z

+
+On iOS and Android, the library does not sanitize HTML. It makes no guarantees that the markup it accepts or produces is safe. You are fully responsible for sanitizing any HTML you persist, render elsewhere, or accept from untrusted sources.
+
+Sanitization _is_ enforced on the web, as injecting unsafe HTML directly into the DOM poses severe security risks (like XSS).


Shouldn't this be ?

Suggested change

Sanitization _is_ enforced on the web, as injecting unsafe HTML directly into the DOM poses severe security risks (like XSS).

Sanitization **is** enforced on the web, as injecting unsafe HTML directly into the DOM poses severe security risks (like XSS).

exploIF · 2026-08-11T16:29:40Z

+## Fixed set of HTML tags
+
+The library intentionally works with a fixed, curated set of standard and
+custom HTML tags rather than accepting arbitrary markup. Tags outside that set
+are stripped or normalized away when they enter the editor. This is a
+deliberate design decision: it keeps the produced HTML portable and guarantees
+that the `EnrichedTextInput` and the `EnrichedText` display render identically. See
+[Supported tags](/fundamentals/html-format-and-supported-tags) for the full
+list.


I think we can mention that we might implement new functionalities and add support for more tags in the future. We can also mention that if users need some specific tag it's the best to create a feature request in our repo

exploIF · 2026-08-11T16:34:13Z

+- **iOS** - open `apps/example/ios/EnrichedTextInputExample.xcworkspace` in
+  Xcode. Find the sources under **Pods > Development Pods >
+  ReactNativeEnrichedHtml**.
+- **Android** - open `apps/example/android` in Android Studio. Find the sources
+  under **react-native-enriched-html** in the **Android** view.


We have dedicated scripts inside package.json to run proper Xcode workspace or Android project, could you add them here as well?

exploIF · 2026-08-11T16:34:39Z

+yarn example android
+
+# iOS
+yarn example ios


iOS requires installing pods before, let's add a note about it

exploIF · 2026-08-11T16:36:14Z

+The target devices are:
+
+| Platform | Device    | OS                            |
+| -------- | --------- | ----------------------------- |
+| iOS      | iPhone 17 | iOS 26.2                      |
+| Android  | Pixel 9   | API 36 "Baklava" (Android 16) |


Let's make it clear that tests have to be run exactly on those devices, as we are using visual regression testing so using the same screen dimensions and resolution is crucial

exploIF · 2026-08-11T16:37:28Z

+
+Always review newly saved screenshots before committing them.
+
+:::note Flaky Android tests on macOS


I would definitely rename it. Tests are not flaky and that's the Android emulator limitation

Suggested change

:::note Flaky Android tests on macOS

:::note Running Android tests on macOS

exploIF · 2026-08-11T16:39:15Z

+
+:::
+
+When you send a pull request:


Let's add a note that if something is unclear or contributor is not sure about proper API it's totally fine to open GitHub issues or discussions and maintainers will help ;)

hejsztynx added 2 commits July 23, 2026 12:10

feat: wip

be2cc76

feat: remove irrelevant content

31ecc4e

hejsztynx requested a review from Copilot July 23, 2026 10:56

hejsztynx changed the title ~~@ksienkiewicz/docs misc~~ docs: miscellaneous section Jul 23, 2026

Copilot started reviewing on behalf of hejsztynx July 23, 2026 10:56 View session

Copilot AI reviewed Jul 23, 2026

View reviewed changes

Comment thread docs/docs/misc/roadmap.md Outdated

Comment thread docs/docs/misc/contributing.md Outdated

Comment thread docs/docs/misc/compatibility.mdx Outdated

docs: add react native compatibility table

9dc732a

kacperzolkiewski marked this pull request as draft July 23, 2026 11:32

docs: add comparison with other libraries

d3aec98

kacperzolkiewski requested a review from Copilot July 23, 2026 12:54

Copilot started reviewing on behalf of kacperzolkiewski July 23, 2026 12:54 View session

Copilot AI reviewed Jul 23, 2026

View reviewed changes

Comment thread docs/src/components/Compatibility/EnrichedCompatibility.tsx

Comment thread docs/src/components/Compatibility/EnrichedCompatibility.tsx Outdated

fix: review changes

0bc11a9

kacperzolkiewski marked this pull request as ready for review July 23, 2026 15:40

kacperzolkiewski requested review from exploIF, kacperzolkiewski and szydlovsky July 23, 2026 15:40

kacperzolkiewski reviewed Jul 24, 2026

View reviewed changes

Comment thread docs/docs/misc/compatibility.mdx Outdated

kacperzolkiewski reviewed Jul 24, 2026

View reviewed changes

Comment thread docs/docs/misc/contributing.md

kacperzolkiewski reviewed Jul 24, 2026

View reviewed changes

Comment thread docs/docs/misc/contributing.md Outdated

hejsztynx and others added 6 commits July 24, 2026 15:54

Update docs/docs/misc/compatibility.mdx

b034548

Co-authored-by: Kacper Żółkiewski <74975508+kacperzolkiewski@users.noreply.github.com>

docs: acknowledge exampe-web app

dab6c7d

docs: unnecessary rn new arch note

c0dc699

docs: link swm

ef5f475

fix: library description

584c241

Merge branch 'feat/docs' into @ksienkiewicz/docs-misc

5e8cd00

szydlovsky reviewed Aug 10, 2026

View reviewed changes

Comment thread docs/docs/misc/compatibility.mdx Outdated

Comment thread docs/docs/misc/compatibility.mdx Outdated

Comment thread docs/docs/misc/comparison-with-other-libraries.md

kacperzolkiewski and others added 3 commits August 10, 2026 18:03

Update docs/docs/misc/compatibility.mdx

38a1b44

Co-authored-by: Mikołaj Szydłowski <9szydlowski9@gmail.com>

Update docs/docs/misc/compatibility.mdx

9018341

Co-authored-by: Mikołaj Szydłowski <9szydlowski9@gmail.com>

fix: remove drag and drop

1f96627

kacperzolkiewski requested a review from szydlovsky August 10, 2026 16:07

szydlovsky approved these changes Aug 10, 2026

View reviewed changes

exploIF reviewed Aug 11, 2026

View reviewed changes

		@@ -0,0 +1,74 @@
		import React from 'react';
		import { No, Version, Yes } from './index';


		On iOS and Android, the library does not sanitize HTML. It makes no guarantees that the markup it accepts or produces is safe. You are fully responsible for sanitizing any HTML you persist, render elsewhere, or accept from untrusted sources.

		Sanitization _is_ enforced on the web, as injecting unsafe HTML directly into the DOM poses severe security risks (like XSS).

	Sanitization _is_ enforced on the web, as injecting unsafe HTML directly into the DOM poses severe security risks (like XSS).
	Sanitization is enforced on the web, as injecting unsafe HTML directly into the DOM poses severe security risks (like XSS).


		Always review newly saved screenshots before committing them.

		:::note Flaky Android tests on macOS

	:::note Flaky Android tests on macOS
	:::note Running Android tests on macOS

Uh oh!

Conversation

hejsztynx commented Jul 23, 2026 • edited by kacperzolkiewski Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

hejsztynx commented Jul 23, 2026 •

edited by kacperzolkiewski

Loading